Skip to content

Update Hub appearance settings

Request

Modifies an existing Hub appearance settings. Only modified attributes may be passed in payload. All other attributes will remain unchanged.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

Query
api_versionstring

Api version

Value:"V3-R1"
Bodyapplication/json
descriptionstring or null

Optional description than can be visible on Hub Page.
May contain basic HTML tags.

navbar_itemobject

Allows to add button with link to Hub Page navbar.
Both label and URL are mandatory if any of those fields contains value.

status_namesobject

Custom labels used on Hub Page legend section.
Can be used to change default values to better match Hub Page use-case.
For example if Hub Page is set to show availability of meeting rooms then 'down' may mean 'Room is not available' and 'degraded-performance' may mean 'Room is booked'.

localizationobject
layoutobject
curl -i -X PUT \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/appearance?api_version=V3-R1' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "description": "string",
    "navbar_item": {
      "label": "Support portal",
      "url": "https://help.example-company.com"
    },
    "status_names": {
      "up": "Service is operating normally",
      "degraded-performance": "Performance issues",
      "down": "Service disruption"
    },
    "localization": {
      "iso_week": true,
      "date_format": "EU",
      "time_format": "12h",
      "time_zone_name": "string"
    },
    "layout": {
      "view_type": "list",
      "background_color": "#ffffff",
      "platform_alerts": true,
      "hubs_switcher": true,
      "show_in_hubs_switcher": true,
      "uptime_chart": true,
      "whitelabel": true
    }
  }'

Responses

OK

Bodyapplication/json
descriptionstring or null

Optional description than can be visible on Hub Page.
May contain basic HTML tags.

favicon_urlstring or null, (uri)

URL of Hub favicon image.

logo_urlstring or null, (uri)

URL of Hub logo image.

navbar_itemobject

Allows to add button with link to Hub Page navbar.
Both label and URL are mandatory if any of those fields contains value.

status_namesobject

Custom labels used on Hub Page legend section.
Can be used to change default values to better match Hub Page use-case.
For example if Hub Page is set to show availability of meeting rooms then 'down' may mean 'Room is not available' and 'degraded-performance' may mean 'Room is booked'.

localizationobject
layoutobject
Response
{
  "description": "string",
  "favicon_url": "http://example.com",
  "logo_url": "http://example.com",
  "navbar_item": {
    "label": "Support portal",
    "url": "https://help.example-company.com"
  },
  "status_names": {
    "up": "Service is operating normally",
    "degraded-performance": "Performance issues",
    "down": "Service disruption"
  },
  "localization": {
    "iso_week": true,
    "date_format": "EU",
    "time_format": "12h",
    "time_zone_name": "string"
  },
  "layout": {
    "view_type": "list",
    "background_color": "#ffffff",
    "platform_alerts": true,
    "hubs_switcher": true,
    "show_in_hubs_switcher": true,
    "uptime_chart": true,
    "whitelabel": true,
    "background_image_url": "http://example.com"
  }
}